Skip to content

HPCC-34056 Remove outdated OS references in Docs #19872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 5, 2025
Merged

HPCC-34056 Remove outdated OS references in Docs #19872

merged 1 commit into from
Jun 5, 2025

Conversation

g-pan
Copy link
Member

@g-pan g-pan commented May 15, 2025 •
edited
Loading

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

All unit tests passed: https://github.com/g-pan/github-action-dev-build/actions/runs/15045689482

@g-pan g-pan requested review from JamesDeFabia and Copilot May 15, 2025 13:41
Copilot
Copilot AI reviewed May 15, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request removes outdated OS references in the documentation for installing and running the HPCC Platform. The changes replace specific OS names (like CentOS 6 and Ubuntu 14.04) with generic "older System V based systems" terminology to modernize and simplify the instructions.

  • Removed specific references to obsolete OS versions.
  • Standardized OS description terminology in multiple documentation sections.
Comments suppressed due to low confidence (1)

docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml:361

  • [nitpick] Consider revising the sentence for clarity. For example, change it to 'If you are using an older System V based system, please see the Appendix: System V' to improve the readability and grammatical structure.
<para><emphasis role="bold">Note:</emphasis> If you are older System V based system, please see the <link

@github-actions GitHub Actions
Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-34056

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR

JamesDeFabia
JamesDeFabia requested changes May 15, 2025
View reviewed changes
Copy link
Contributor

@JamesDeFabia JamesDeFabia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments/questions inline
Adding @Michael-Gardner to reviewers

docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml Outdated
<para><emphasis role="bold">Note:</emphasis> If you are using Cent
OS 6, Ubuntu 14.04, or another System V based system, please see
the <link linkend="hpcc-init">Appendix: System V</link>.</para>
<para><emphasis role="bold">Note:</emphasis> If you are older
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing a word... If you are older s/b If you are using an older.

docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml Outdated
@@ -2040,7 +2040,7 @@ sudo /etc/init.d/hpcc-init -c esp start
<title>HPCC Systems systemd services</title>

<para>HPCC Systems is extending support and development to more
systemd services. We intend to continue support for Cent OS 6 and
systemd services. We intend to continue support for older Cent OS and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this true? Are we still supporting older OS versions and SystemV? Ask @Michael-Gardner to review this PR

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Michael-Gardner please review

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jim there is no ticket right now, or conversation that I am privy to, about us removing the old init scripts from the platform code. I think the way we should probably phrase this is like "We intend to continue support for older System V based systems through the hpcc-init" And drop the centos reference.

@g-pan g-pan requested review from Copilot and JamesDeFabia May 16, 2025 15:23
Copilot
Copilot AI reviewed May 16, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes outdated operating system references from the documentation to prevent confusion and maintain relevance.

  • Removed specific OS version references (e.g. Cent OS 6, Ubuntu 14.04)
  • Generalized OS descriptions to "older System V based systems"
  • Updated multiple documentation sections accordingly
Comments suppressed due to low confidence (1)

docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml:2043

  • [nitpick] Consider using the consistent spelling 'CentOS' rather than 'Cent OS' to align with standard naming conventions.
systemd services. We intend to continue support for older Cent OS and

JamesDeFabia
JamesDeFabia approved these changes May 16, 2025
View reviewed changes
Copy link
Contributor

@JamesDeFabia JamesDeFabia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK from my POV, but needs Michel's confirmation about SystemV support, etc

Michael-Gardner
Michael-Gardner requested changes May 28, 2025
View reviewed changes
docs/EN_US/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml Outdated
@@ -2040,7 +2040,7 @@ sudo /etc/init.d/hpcc-init -c esp start
<title>HPCC Systems systemd services</title>

<para>HPCC Systems is extending support and development to more
systemd services. We intend to continue support for Cent OS 6 and
systemd services. We intend to continue support for older Cent OS and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jim there is no ticket right now, or conversation that I am privy to, about us removing the old init scripts from the platform code. I think the way we should probably phrase this is like "We intend to continue support for older System V based systems through the hpcc-init" And drop the centos reference.

@g-pan g-pan requested a review from Michael-Gardner May 28, 2025 14:34
Michael-Gardner
Michael-Gardner approved these changes Jun 2, 2025
View reviewed changes
Copy link
Contributor

@Michael-Gardner Michael-Gardner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Greg! Looks great.

@ghalliday ghalliday merged commit a5567c8 into hpcc-systems:candidate-9.12.x Jun 5, 2025
55 of 56 checks passed
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 5, 2025

Jirabot Action Result:
Added fix version: 9.12.10
Workflow Transition: 'Resolve issue'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@JamesDeFabia JamesDeFabia JamesDeFabia approved these changes

@Michael-Gardner Michael-Gardner Michael-Gardner approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@g-pan @JamesDeFabia @Michael-Gardner @ghalliday